core/androidx.core.app/[main]ShareCompat/IntentBuilder

IntentBuilder

IntentBuilder is a helper for constructing ACTION_SEND and ACTION_SEND_MULTIPLE sharing intents and starting activities to share content. The ComponentName and package name of the calling activity will be included.

Constructors

IntentBuilder

constructor(@NonNull launchingContext: @NonNull Context)

Create a new IntentBuilder for launching a sharing action from launchingContext.

Functions

addEmailBcc

@NonNull

open fun addEmailBcc(@NonNull address: @NonNull String): @NonNull ShareCompat.IntentBuilder

Add an email address to be used in the "bcc" field of the final Intent.

@NonNull

open fun addEmailBcc(addresses: @NonNull Array<String>): @NonNull ShareCompat.IntentBuilder

Add an array of email addresses to be used in the "bcc" field of the final Intent.

addEmailCc

@NonNull

open fun addEmailCc(@NonNull address: @NonNull String): @NonNull ShareCompat.IntentBuilder

Add an email address to be used in the "cc" field of the final Intent.

@NonNull

open fun addEmailCc(addresses: @NonNull Array<String>): @NonNull ShareCompat.IntentBuilder

Add an array of email addresses to be used in the "cc" field of the final Intent.

addEmailTo

@NonNull

open fun addEmailTo(@NonNull address: @NonNull String): @NonNull ShareCompat.IntentBuilder

Add an email address to be used in the "to" field of the final Intent.

@NonNull

open fun addEmailTo(addresses: @NonNull Array<String>): @NonNull ShareCompat.IntentBuilder

Add an array of email addresses to be used in the "to" field of the final Intent.

addStream

@NonNull

open fun addStream(@NonNull streamUri: @NonNull Uri): @NonNull ShareCompat.IntentBuilder

Add a stream URI to the data that should be shared.

createChooserIntent

@NonNull

open fun createChooserIntent(): @NonNull Intent

Create an Intent that will launch the standard Android activity chooser, allowing the user to pick what activity/app on the system should handle the share.

from

@NonNull

open fun ~~from~~(@NonNull launchingActivity: @NonNull Activity): @NonNull ShareCompat.IntentBuilder

Create a new IntentBuilder for launching a sharing action from launchingActivity.

getIntent

@NonNull

open fun getIntent(): @NonNull Intent

Retrieve the Intent as configured so far by the IntentBuilder.

setChooserTitle

@NonNull

open fun setChooserTitle(@StringRes resId: Int): @NonNull ShareCompat.IntentBuilder

@NonNull

open fun setChooserTitle(@Nullable title: @Nullable CharSequence): @NonNull ShareCompat.IntentBuilder

Set the title that will be used for the activity chooser for this share.

setEmailBcc

@NonNull

open fun setEmailBcc(addresses: @Nullable Array<String>): @NonNull ShareCompat.IntentBuilder

Set an array of email addresses to BCC on this share.

setEmailCc

@NonNull

open fun setEmailCc(addresses: @Nullable Array<String>): @NonNull ShareCompat.IntentBuilder

Set an array of email addresses to CC on this share.

setEmailTo

@NonNull

open fun setEmailTo(addresses: @Nullable Array<String>): @NonNull ShareCompat.IntentBuilder

Set an array of email addresses as recipients of this share.

setHtmlText

@NonNull

open fun setHtmlText(@Nullable htmlText: @Nullable String): @NonNull ShareCompat.IntentBuilder

Set an HTML string to be sent as part of the share.

setStream

@NonNull

open fun setStream(@Nullable streamUri: @Nullable Uri): @NonNull ShareCompat.IntentBuilder

Set a stream URI to the data that should be shared.

setSubject

@NonNull

open fun setSubject(@Nullable subject: @Nullable String): @NonNull ShareCompat.IntentBuilder

Set a subject heading for this share; useful for sharing via email.

setText

@NonNull

open fun setText(@Nullable text: @Nullable CharSequence): @NonNull ShareCompat.IntentBuilder

Set the literal text data to be sent as part of the share.

setType

@NonNull

open fun setType(@Nullable mimeType: @Nullable String): @NonNull ShareCompat.IntentBuilder

Set the type of data being shared

startChooser

open fun startChooser()

Start a chooser activity for the current share intent.